home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / icon tools / mriconsort / mriconsort.doc < prev    next >
Text File  |  1996-04-07  |  10KB  |  294 lines
  1. Copyright (C) 1993 Mark R. Rinfret, MRsoftware All Rights Reserved.
  2.  
  3. Permission is granted to make and distribute verbatim copies of this
  4. manual provided the copyright notice and this permission notice are
  5. preserved on all copies.
  6.  
  7.  
  8. This file documents the `MRIconSort' icon sorting tool for the Amiga
  9. family of computers.
  10.  
  11.  
  12. Permissions
  13. ************
  14.  
  15.      Copyright (C) 1993 Mark R. Rinfret, MRsoftware
  16.      All Rights Reserved.
  17.  
  18. MRIconSort is freely distributable shareware.  It may be redistributed
  19. via magnetic media or electronic bulletin board systems (BBS).  It is
  20. unlawful to charge a fee for this software other than reasonable
  21. distribution/media fees.
  22.  
  23. The author assumes no responsibilty for damages incurred as a result of
  24. using MRIconSort.  USE AT YOUR OWN RISK!  No warranties, either
  25. expressed or implied, are made with regard to its use on any system.
  26.  
  27. Once you have tried MRIconSort and have decided to continue using it,
  28. you are requested to submit five dollars ($5.00 U.S.) to the author. 
  29. You should also provide the following information:
  30.  
  31.          Your mail address
  32.          Your e-mail address(es), if any
  33.          The version of MRIconSort you are registering
  34.  
  35. Send this to:
  36.  
  37.          MRsoftware
  38.          348 Indian Avenue
  39.          Portsmouth, RI  02871
  40.  
  41.  
  42. Overview
  43. *********
  44.  
  45. MRIconSort (Mark Rinfret's Icon Sort - go ahead, call it "Mister Icon
  46. Sort" :-) is a tool which will alphabetize and align your WorkBench
  47. icons, creating order where there is chaos.
  48.  
  49. Though the WorkBench interface has its niceties, things can run amuck
  50. when you have drawers containing many icons. Things become especially
  51. confusing when most of those icons look the same (large groups of
  52. pictures, drawers, etc.). The same visual cues that make the WorkBench
  53. powerful for drawers containing a few icons render it useless when you
  54. have many similarly sized and shaped icons.
  55.  
  56. MRIconSort scans a directory (or a full directory hierarchy) and
  57. rearranges the icons to make navigating a WorkBench window much more
  58. orderly.  You can choose to group icons by files first, directories
  59. first or mixed (no preference).  Then, icons are alphabetized and
  60. aligned from left to right.  The vertical spacing of the icons is
  61. arranged such that the tallest icon in any row determines the height of
  62. that row and all icon text sits on the same baseline, making it easy to
  63. scan all names without getting a case of the "jumpy eyeball".
  64.  
  65. MRIconSort knows about icons that have been left out on the desktop (it
  66. reads the :.backdrop file) and leaves them alone. You have your choice
  67. of right "margin": you can either use the WorkBench maximum or
  68. MRIconSort will attempt to get the "snapshot" coordinates of the window
  69. associated with each drawer.
  70.  
  71. MRIconSort can also be told to create default icons for files or
  72. directories which don't have icons.
  73.  
  74. MRIconSort requires AmigaDOS 2.04 and up. It will run from either the
  75. Shell or the WorkBench.
  76.  
  77. MRIconSort's default behavior can be customized through the definition
  78. of a preferences file named `MRIconSort.prefs' (see Installing
  79. MRIconSort).
  80.  
  81.  
  82. Installing MRIconSort
  83. **********************
  84.  
  85. Unpacking the MRIconSort Archive
  86. ================================
  87.  
  88. You most likely received MRIconSort as an Lha archive. It will unpack
  89. into its own directory hierarchy with the following command:
  90.  
  91.      lha -xa x MRIconSort.lha
  92.  
  93. The actual archive name may vary from `MRIconSort.lha' since it may
  94. include a version number. If the archive is unpacked correctly, a new
  95. directory will be created containing the MRIconSort program,
  96. documentation and environment variable directories.
  97.  
  98. Installing the Software
  99. =======================
  100.  
  101. Make the MRIconSort directory the current directory by using the `CD'
  102. command.
  103.  
  104. You can install the MRIconSort program in any suitable directory which
  105. is a part of your command search path (i.e. defined by the AmigaDOS
  106. `PATH' command). For example, if you have a directory named
  107. `SYS:Tools', you could copy the MRIconSort program there with
  108.  
  109.      COPY CLONE MRIconSort MRIconSort.info SYS:Tools
  110.  
  111. It is assumed that you have at least one directory on your system where
  112. document files are stored (though this is not a requirement). It is
  113. quite likely that you have several documentation directories (quite
  114. likely not sharing a common hierarchy).
  115.  
  116. The documentation for MRIconSort comes in three forms:
  117.  
  118.    * A plain text file named `MRIconSort.doc'
  119.  
  120.    * An AmigaGuide(tm) file named `MRIconSort.guide'
  121.  
  122.    * A TeX `DVI' file named `MRIconSort.dvi'.
  123.  
  124. Copy any or all of these to the appropriate online documentation area.
  125.  
  126. Edit MRIconSort Preferences
  127. ===========================
  128.  
  129. When MRIconSort starts up, it first looks for a file name
  130. `MRIconSort.prefs' in the current directory.  If this file doesn't
  131. exist, it then looks for the file `ENV:MRIconSort.prefs'. The default
  132. `MRIconSort.prefs' file is stored in the `MRIconSort' installation
  133. directory as `Env/MRIconSort.prefs'.  This file contains `MRIconSort'
  134. configuration parameters which customize `MRIconSort' behavior to your
  135. unique requirements.
  136.  
  137. The supplied preferences file is self-documenting.  The
  138. `MRIconSort.prefs' file is a text file organized as one directive per
  139. line with lines of comments (lines beginning with a semi-colon)
  140. interspersed with lines of directives.  Here is the supplied
  141. `MRIconSort.prefs' file:
  142.  
  143.      ; This is the MRIconSort configuration file (environment variable).
  144.      ; All directives are included here. Those preceded by ";" are ignored.
  145.      ; To activate any directive, just edit this file to remove the
  146.      ; leading semi-colon from that line.
  147.      ;
  148.      ; All - Process all levels (recursive directory scan).
  149.      ;All
  150.      ;
  151.      ; FilesFirst    - Place all file icons before directory icons.
  152.      FilesFirst
  153.      ;
  154.      ; DirsFirst     - Place all directory icons before file icons.
  155.      ;DIRSFIRST
  156.      ;
  157.      ; Mixed         - Mix file and directory icons on the same line.
  158.      ;Mixed
  159.      ;
  160.      ; XSpace = <number> - Set horizontal spacing between icons (default = 8).
  161.      XSpace = 8
  162.      ;
  163.      ; YSpace = <number> - Set vertical spacing between icons (default = 2).
  164.      YSpace = 2
  165.      ;
  166.      ; MaxWidth -    - Use the maximum WorkBench screen width.
  167.      ;                 (If absent, use icon's window snapshot.)
  168.      ;MaxWidth
  169.  
  170. Once these changes are made, copy the environment variable directory to
  171. both the ENV: and ENVARC: directories:
  172.  
  173.      COPY CLONE ALL Env ENV:
  174.      COPY CLONE ALL Env ENVARC:
  175.  
  176. If you are make changes to your global MRIconSort Preferences, remember
  177. to copy the ENV:MRIconSort.prefs file to ENVARC:. Otherwise, your
  178. changes will be lost the next time you reboot your system.
  179.  
  180.  
  181. Using MRIconSort
  182. *****************
  183.  
  184. MRIconSort can be invoked from the WorkBench or the Shell. There are
  185. distinct differences in its behavior under each environment.
  186.  
  187.  
  188. Shell Operation
  189. ****************
  190.  
  191. When run from the Shell, `MRIconSort' attempts to read the preferences
  192. file, `MRIconSort.prefs', first from the current directory and, if no
  193. file is found there, from `ENV:MRIconSort.prefs'.  Any command line
  194. parameters then override the preferences settings.  The basic format of
  195. the command line is:
  196.  
  197.      MRIconSort <directory_name> <options>
  198.  
  199. The MRIconSort command template is:
  200.  
  201.      Dir/A,DirsFirst/S,FilesFirst/S,Mixed/S,Create/S,All/S,MaxWidth/S,
  202.      XSpace/K/N,YSpace/K/N
  203.  
  204. MRIconSort's parameters are defined as follows:
  205.    * Dir
  206.      This is the name of the directory whose icon's are to be
  207.      sorted/created.
  208.  
  209.    * DirsFirst
  210.      This is a switch which indicates that directory icons are to
  211.      appear before file icons. The default is FilesFirst.
  212.  
  213.    * FilesFirst
  214.      This is a switch which indicates that file icons are to appear
  215.      before directory icons. This is the default behavior.
  216.  
  217.    * Mixed
  218.      This is a switch which indictes that no preference is to be given
  219.      to the order of file and directory icons (i.e. they will be mixed).
  220.  
  221.    * Create
  222.      This is a switch which turns on icon creation for any files or
  223.      directories not having an icon.
  224.  
  225.    * All
  226.      This switch instructs `MRIconSort' to sort all levels (descend the
  227.      directory tree).
  228.  
  229.    * MaxWidth
  230.      Normally, `MRIconSort' will attempt to obtain the WorkBench window
  231.      dimension "snapshot" for the drawer being organized and use the
  232.      window width as the right-hand margin for each row of icons.
  233.      However, if this switch is specified, `MRIconSort' will use the
  234.      current WorkBench screen width.
  235.  
  236.    * XSpace = <pixels>
  237.      This parameter specifies the horizontal spacing factor.
  238.      `MRIconSort' defaults to 8 pixels.
  239.  
  240.    * XYspace = <pixels>
  241.      This parameter specifies the vertical spacing factor. MRIconSort
  242.      defaults to 2 pixels.
  243.  
  244.  
  245. WorkBench Operation
  246. ********************
  247.  
  248. When `MRIconSort' is invoked from the WorkBench, it will first attempt
  249. to read its preferences settings from the `ENV:MRIconSort.prefs' file
  250. and then will override these settings with any ToolType entries it may
  251. find in its tool icon. The `MRIconSort' ToolType entries are identical
  252. in name and syntax to the command line template definitions (see Shell
  253. Operation) with the exception of the `Dir' parameter which cannot be
  254. specified as a ToolType.
  255.  
  256. Multiple directories can be processed when running from the WorkBench.
  257. Simply shift-select the icons for the drawers you want to process.
  258.  
  259.  
  260. Things to Do
  261. *************
  262.  
  263. I intend to evolve and improve `MRIconSort' over time.  Your input will
  264. be greatly appreciated.  Some of the changes planned (not necessarily
  265. in any particular order) are:
  266.  
  267.    * Grid Snap
  268.      This option will force icons to snap to an invisible grid.
  269.  
  270.    * Window Dimension Setting
  271.      This option will reset all drawer window dimensions to a
  272.      user-specified value.
  273.  
  274.    * Icon Creation Exclusion List
  275.      This feature will inhibit icon creation for filenames matching a
  276.      list of patterns (e.g.  *.c, *.o, etc.).
  277.  
  278.  
  279. Concept Index
  280. **************
  281.  
  282.  
  283.  
  284.  Environment Variables                  Overview
  285.  Installation                           Installing MRIconSort
  286.  MRIconSort Preferences                 Installing MRIconSort
  287.  Overview                               Overview
  288.  Permissions                            Permissions
  289.  Plans for the Future                   Things to Do
  290.  Shell Operation                        Shell Operation
  291.  Using MRIconSort                       Using MRIconSort
  292.  WorkBench Operation                    WorkBench Operation
  293.  
  294.